Fix broken docs jobs and update-client script by stephenfin · Pull Request #2498 · kubernetes-client/python

stephenfin · 2026-01-09T11:14:41Z

What type of PR is this?

/kind cleanup

What this PR does / why we need it:

While working on #2496 and #2497, I noticed that running the update-client.sh script generated some unexpected changes to files. Upon further inspection, it appears files and hunks were the result of previous PRs that should have instead been applies as patches to the client (via the update-client.sh script).

In addition, I also noticed that docs builds were returning a lot of errors, mainly because the generator is generating syntactically invalid reStructuredText docstrings. This has led to a long-term failure to build the docs.

I resolve all issues in this PR via a series of commits that do the following:

Remove auto-generated client docs. We can re-add these in the future and users can use the REPL and/or pydoc to explore the API until then.
Update the docs build to reflect the demise of Python 2 and address some other minor issues
Update the tox configuration to allow users to run tests using tox again
Update the update-client.sh so that we layer on required changes

This should set us up nicely for a future PR that will update openapi-generator to a less ancient version. I am working on this currently.

Which issue(s) this PR fixes:

Special notes for your reviewer:

I don't know why the maintainers aren't seeing these issues locally: perhaps they are and have local tooling to help workaround them. In any case, I would encourage you to go through this PR commit by commit and to feel free to drop anything that doesn't make sense.

Does this PR introduce a user-facing change?

NONE

Additional documentation e.g., KEPs (Kubernetes Enhancement Proposals), usage docs, etc.:

These have not built successfully for a long-time (over two years [1] at time of writing). We should work to re-add these but lets focus on getting out openapi-generator version bumped first. [1] https://app.readthedocs.org/projects/kubernetes/builds/ Signed-off-by: Stephen Finucane <stephenfin@redhat.com>

Update examples that were moved in kubernetes-client#938 and fix title underlines (docutils cares about this stuff). Signed-off-by: Stephen Finucane <stephenfin@redhat.com>

Remove Python 2 stuff as well as unused or commented out configuration values. Also add sphinx to the dependencies Signed-off-by: Stephen Finucane <stephenfin@redhat.com>

Use more recent Python versions and remove use of the build_sphinx distutils command which hasn't existed for many years now. Signed-off-by: Stephen Finucane <stephenfin@redhat.com>

k8s-ci-robot · 2026-01-09T11:14:49Z

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by: stephenfin
Once this PR has been reviewed and has the lgtm label, please assign roycaihw for approval. For more information see the Code Review Process.

The full list of commands accepted by this bot can be found here.

Details

Needs approval from an approver in each of these files:

OWNERS

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

Python 3.13 is the latest and greatest. Signed-off-by: Stephen Finucane <stephenfin@redhat.com>

We will subsequently overlay our own commits on this. We also stop setting OPENAPI_GENERATOR_COMMIT: this is already being set by the 'openapi/python.sh' from 'kubernetes-client/gen' so setting it here is very misleading. With this change, any user should now be able to run e.g.: USERNAME=kubernetes CLIENT_ROOT=../kubernetes ./scripts/update-client.sh and see zero changes (assuming kubernetes/kubernetes is in fact cloned to the parent directory). Signed-off-by: Stephen Finucane <stephenfin@redhat.com>

This was replacing the wrong method. Signed-off-by: Stephen Finucane <stephenfin@redhat.com>

roycaihw · 2026-01-15T21:36:28Z

/assign

k8s-ci-robot · 2026-01-29T02:03:39Z

PR needs rebase.

Details

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository.

roycaihw

Thanks for driving this! Some minor comments and otherwise LGTM. I suggest keeping this PR focused on doc changes.

roycaihw · 2026-02-24T16:45:11Z

doc/source/index.rst

@@ -1,8 +1,3 @@
-.. kubernetes-python-client documentation master file, created by


Doc built failed with

No default configuration file found at repository's root. See https://docs.readthedocs.io/en/stable/config-file/

And the documentation has been stale since v28: https://kubernetes.readthedocs.io/en/latest/README.html#documentation

I'm okay with dropping the documentation for now but we should aim for fixing the doc after we bump the code generator version, ideally before the next release cut.

roycaihw · 2026-02-24T16:58:35Z

scripts/update-client.sh

 set -o pipefail

-# The openapi-generator version used by this client
-export OPENAPI_GENERATOR_COMMIT="v4.3.0"


Could you make this change in #2499? Let's keep this PR focus on doc changes.

roycaihw · 2026-02-24T16:59:12Z

scripts/update-client.sh

+# This is a hack: openapi-generator shouldn't be producing syntactically
+# incorrect tests
+echo ">>> Removing broken tests"
+git clean -fd -- kubernetes/test/


Similar here. Could you make this change in #2499? Let's keep this PR focus on doc changes.

roycaihw · 2026-02-24T17:01:08Z

tox.ini

+  {[testenv:coverage]commands}
+  python -m coverage xml

-[testenv:update-pycodestyle]


I noticed that pycodestyle was removed. Was it replaced by a different tool?

roycaihw · 2026-02-24T17:05:01Z

tox.ini

@@ -1,26 +1,37 @@
 [tox]
 envlist =
-   py3{6,7,8,9}


Are we ready to drop 3.6-3.9?

roycaihw · 2026-02-24T17:09:06Z

scripts/hotfixes.diff

@@ -0,0 +1,188 @@
+diff --git a/kubernetes/client/api/custom_objects_api.py b/kubernetes/client/api/custom_objects_api.py


This replaces apply-hotfixes.sh, but it's not yet cleaned up here

python/scripts/release.sh

Line 214 in 9a8be12

scripts/apply-hotfixes.sh

I'd suggest doing this replacement (and the cleanup) in a separate PR.

stephenfin added 4 commits January 8, 2026 18:34

Update included examples

d5ead18

Update examples that were moved in kubernetes-client#938 and fix title underlines (docutils cares about this stuff). Signed-off-by: Stephen Finucane <stephenfin@redhat.com>

Improve docs build process

8a8ec14

Remove Python 2 stuff as well as unused or commented out configuration values. Also add sphinx to the dependencies Signed-off-by: Stephen Finucane <stephenfin@redhat.com>

Fix tox configuration

6449a9d

Use more recent Python versions and remove use of the build_sphinx distutils command which hasn't existed for many years now. Signed-off-by: Stephen Finucane <stephenfin@redhat.com>

k8s-ci-robot added release-note-none Denotes a PR that doesn't merit a release note. kind/cleanup Categorizes issue or PR as related to cleaning up code, process, or technical debt. labels Jan 9, 2026

k8s-ci-robot requested review from roycaihw and yliaog January 9, 2026 11:14

k8s-ci-robot added size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. labels Jan 9, 2026

stephenfin added 2 commits January 9, 2026 11:15

Add testing for Python 3.13

59885b6

Python 3.13 is the latest and greatest. Signed-off-by: Stephen Finucane <stephenfin@redhat.com>

stephenfin force-pushed the fix-openapi-generator-sync branch from cd87cd5 to a7008b0 Compare January 9, 2026 11:15

Remove broken patch

c97e1a7

This was replacing the wrong method. Signed-off-by: Stephen Finucane <stephenfin@redhat.com>

This was referenced Jan 9, 2026

Remove use of deprecated urllib3 functionality #2497

Closed

Bump openapi-generator to v6.6.0 #2499

Open

k8s-ci-robot assigned roycaihw Jan 15, 2026

k8s-ci-robot added the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label Jan 29, 2026

roycaihw reviewed Feb 24, 2026

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Fix broken docs jobs and update-client script#2498

Fix broken docs jobs and update-client script#2498
stephenfin wants to merge 7 commits intokubernetes-client:masterfrom
stephenfin:fix-openapi-generator-sync

stephenfin commented Jan 9, 2026 •

edited

Loading

Uh oh!

k8s-ci-robot commented Jan 9, 2026

Uh oh!

roycaihw commented Jan 15, 2026

Uh oh!

k8s-ci-robot commented Jan 29, 2026

Uh oh!

roycaihw left a comment

Uh oh!

roycaihw Feb 24, 2026

Uh oh!

roycaihw Feb 24, 2026

Uh oh!

roycaihw Feb 24, 2026

Uh oh!

roycaihw Feb 24, 2026

Uh oh!

roycaihw Feb 24, 2026

Uh oh!

roycaihw Feb 24, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

		@@ -1,8 +1,3 @@
		.. kubernetes-python-client documentation master file, created by

		@@ -0,0 +1,188 @@
		diff --git a/kubernetes/client/api/custom_objects_api.py b/kubernetes/client/api/custom_objects_api.py

Conversation

stephenfin commented Jan 9, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

What type of PR is this?

What this PR does / why we need it:

Which issue(s) this PR fixes:

Special notes for your reviewer:

Does this PR introduce a user-facing change?

Additional documentation e.g., KEPs (Kubernetes Enhancement Proposals), usage docs, etc.:

Uh oh!

k8s-ci-robot commented Jan 9, 2026

Uh oh!

roycaihw commented Jan 15, 2026

Uh oh!

k8s-ci-robot commented Jan 29, 2026

Uh oh!

roycaihw left a comment

Choose a reason for hiding this comment

Uh oh!

roycaihw Feb 24, 2026

Choose a reason for hiding this comment

Uh oh!

roycaihw Feb 24, 2026

Choose a reason for hiding this comment

Uh oh!

roycaihw Feb 24, 2026

Choose a reason for hiding this comment

Uh oh!

roycaihw Feb 24, 2026

Choose a reason for hiding this comment

Uh oh!

roycaihw Feb 24, 2026

Choose a reason for hiding this comment

Uh oh!

roycaihw Feb 24, 2026

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

stephenfin commented Jan 9, 2026 •

edited

Loading